home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 February: Tool Chest / Apple Developer CD Series Tool Chest February 1996 (Apple Computer)(1996).iso / Tool Chest / Development Tools & Languages / Macintosh Common Lisp Related / interfaces / AOCE folder / DigitalSignature.lisp < prev    next >
Encoding:
Text File  |  1994-09-12  |  18.2 KB  |  421 lines  |  [TEXT/CCL2]
  1.  
  2. (in-package :TRAPS)             ; ***********************************************************
  3. ; 
  4. ; Created: Sunday, February 7, 1993 at 4:54PM
  5. ;  DigitalSignature.p
  6. ;  Pascal Interface to the Macintosh Libraries
  7. ; 
  8. ;     ••• Apple Confidential •••
  9. ;     ••• Provided with AOCE Beta seed under license agreement with   •••
  10. ;     ••• Apple Computer, Inc.  Use for any purpose other than        •••
  11. ;     ••• development of AOCE-based Macintosh products is a violation •••
  12. ;     ••• of the license agreement.                                   •••
  13. ; 
  14. ;   Copyright Apple Computer, Inc. 1990-1993
  15. ;   All rights reserved
  16. ; 
  17. ; ***********************************************************
  18.  
  19. ; $IFC UNDEFINED UsingIncludes
  20. ; $SETC UsingIncludes:= 0
  21. ; $ENDC
  22.  
  23. ; $IFC NOT UsingIncludes
  24.  
  25. ; $ENDC
  26.  
  27. ; $IFC UNDEFINED UsingDigitalSignature
  28. ; $SETC UsingDigitalSignature:= 1
  29.  
  30. ; $I+
  31. ; $SETC DigitalSignatureIncludes:= UsingIncludes
  32. ; $SETC UsingIncludes:= 1
  33.  
  34. ; $IFC UNDEFINED UsingFiles
  35.  
  36. (require-interface 'FILES)      ; $I $$Shell(PInterfaces)Files.p
  37. ; $ENDC
  38.  
  39. ; $IFC UNDEFINED UsingMemory
  40.  
  41. (require-interface 'MEMORY)     ; $I $$Shell(PInterfaces)Memory.p
  42. ; $ENDC
  43.  
  44. ; $IFC UNDEFINED UsingTypes
  45.  
  46. (require-interface 'TYPES)      ; $I $$Shell(PInterfaces)Types.p
  47. ; $ENDC
  48.  
  49. ; $SETC UsingIncludes:= DigitalSignatureIncludes
  50.  
  51. ;  —————————————————————————— TRAP SELECTORS —————————————————————————— 
  52.  
  53. (defconstant $kSIGNewContext 1900)
  54. (defconstant $kSIGDisposeContext 1901)
  55.  
  56. (defconstant $kSIGSignPrepare 1902)
  57. (defconstant $kSIGSign 1903)
  58.  
  59. (defconstant $kSIGVerifyPrepare 1904)
  60. (defconstant $kSIGVerify 1905)
  61.  
  62. (defconstant $kSIGDigestPrepare 1906)
  63. (defconstant $kSIGDigest 1907)
  64.  
  65. (defconstant $kSIGProcessData 1908)
  66.  
  67. (defconstant $kSIGShowSigner 1909)
  68. (defconstant $kSIGGetSignerInfo 1910)
  69. (defconstant $kSIGGetCertInfo 1911)
  70. (defconstant $kSIGGetCertNameAttributes 1912)
  71. (defconstant $kSIGGetCertIssuerNameAttributes 1913)
  72.  
  73. (defconstant $kSIGFileIsSigned 2500)
  74. (defconstant $kSIGSignFile 2501)
  75. (defconstant $kSIGVerifyFile 2502)
  76.  
  77. ;  values of SIGNameAttributeType 
  78. (defconstant $kSIGCountryCode 0)
  79. (defconstant $kSIGOrganization 1)
  80. (defconstant $kSIGStreetAddress 2)
  81. (defconstant $kSIGState 3)
  82. (defconstant $kSIGLocality 4)
  83. (defconstant $kSIGCommonName 5)
  84. (defconstant $kSIGTitle 6)
  85. (defconstant $kSIGOrganizationUnit 7)
  86. (defconstant $kSIGPostalCode 8)
  87.  
  88. (def-mactype :SIGNAMEATTRIBUTETYPE (find-mactype :SIGNED-INTEGER))
  89.  
  90. ; 
  91. ; Certificate status codes returned in SIGCertInfo or SIGSignerInfo from
  92. ; either SIGGetCertInfo or SIGGetSignerInfo respectively. kSIGValid means that
  93. ; the certificate is currently valid. kSIGPending means the certificate is
  94. ; currently not valid - but will be.  kSIGExpired means the certificate has
  95. ; expired. A time is always associated with a SIGCertStatus.  In each case the
  96. ; time has a specific interpretation.  When the status is kSIGValid the time is
  97. ; when the certificate will expire. When the status is kSIGPending the time is
  98. ; when the certificate will become valid. When the status is kSIGExpired the time
  99. ; is when the certificate expired. In the SIGCertInfo structure, the startDate
  100. ; and endDate fields hold the appropriate date information.  In the SIGSignerInfo
  101. ; structure, this information is provided in the certSetStatusTime field. In the
  102. ; SIGSignerInfo struct, the status time is actually represented by the SIGSignatureStatus
  103. ; field which can contain any of the types below. NOTE: The only time you will get
  104. ; a kSIGInvalid status is when it pertains to a SIGSignatureStatus field and only when
  105. ; you get a signature that was created after the certificates expiration date, something
  106. ; we are not allowing on the Mac but that may not be restricted on other platforms. Also,
  107. ; it will not be possible to get a kSIGPending value for SIGSignatureStatus on the Mac but
  108. ; possibly allowed by other platforms.
  109. ; 
  110.  
  111. ;  Values for SIGCertStatus or SIGSignatureStatus 
  112.  
  113. (defconstant $kSIGValid 0)      ;  possible for either a SIGCertStatus or SIGSignatureStatus 
  114. (defconstant $kSIGPending 1)    ;  possible for either a SIGCertStatus or SIGSignatureStatus 
  115. (defconstant $kSIGExpired 2)    ;  possible for either a SIGCertStatus or SIGSignatureStatus 
  116. (defconstant $kSIGInvalid 3)    ;  possible only for a SIGSignatureStatus 
  117.  
  118. (def-mactype :SIGCERTSTATUS (find-mactype :SIGNED-INTEGER))
  119. (def-mactype :SIGSIGNATURESTATUS (find-mactype :SIGNED-INTEGER))
  120.  
  121. ;  Gestalt selector code - returns toolbox version in low-order word 
  122.  
  123. (defconstant $gestaltDigitalSignatureVersion :|dsig|)
  124.  
  125. ;  Number of bytes needed for a digest record when using SIGDigest 
  126. (defconstant $kSIGDigestSize 16)
  127.  
  128. (def-mactype :SIGDIGESTDATA (find-mactype :ARRAY))
  129. (def-mactype :SIGDIGESTDATAPTR (find-mactype :POINTER))
  130.  
  131. (defrecord SIGCertInfo 
  132.    (startDate :SIGNED-LONG)     ;  cert start validity date 
  133.    (endDate :SIGNED-LONG)       ;  cert end validity date 
  134.    (certStatus :SIGNED-INTEGER) ;  see comment on SIGCertStatus for definition 
  135.    (certAttributeCount :SIGNED-LONG);  number of name attributes in this cert 
  136.    (issuerAttributeCount :SIGNED-LONG);  number of name attributes in this certs issuer 
  137.    (serialNumber (:STRING 255)) ;  cert serial number 
  138.    )
  139.  
  140. (def-mactype :SIGCERTINFOPTR (find-mactype :POINTER))
  141.  
  142. (defrecord SIGSignerInfo 
  143.    (signingTime :SIGNED-LONG)   ;  time of signing 
  144.    (certCount :SIGNED-LONG)     ;  number of certificates in the cert set 
  145.    (certSetStatusTime :SIGNED-LONG);  Worst cert status time. See comment on
  146. ;                                             SIGCertStatus for definition 
  147.    (signatureStatus :SIGNED-INTEGER);  The status of the signature. See comment on
  148. ;                                             SIGCertStatus for definition
  149.    )
  150.  
  151. (def-mactype :SIGSIGNERINFOPTR (find-mactype :POINTER))
  152.  
  153. (defrecord SIGNameAttributesInfo 
  154.    (onNewLevel :BOOLEAN)
  155.    (attributeType :SIGNED-INTEGER)
  156.    (attributeScript :SIGNED-INTEGER)
  157.    (attribute (:STRING 255))
  158.    )
  159.  
  160. (def-mactype :SIGNAMEATTRIBUTESINFOPTR (find-mactype :POINTER))
  161.  
  162. (def-mactype :SIGCONTEXTPTR (find-mactype :POINTER))
  163. (def-mactype :SIGSIGNATUREPTR (find-mactype :POINTER))
  164.  
  165. ; 
  166. ; Certificates are always in order. That is, the signers cert is always 0, the
  167. ; issuer of the signers cert is always 1 etc… to the number of certificates-1.
  168. ; You can use this constant for readability in your code.
  169. ; 
  170.  
  171. (defconstant $kSIGSignerCertIndex 0)
  172.  
  173. ; 
  174. ; Call back procedure supplied by developer, return false to cancel the current process.
  175. ; 
  176.  
  177. (def-mactype :SIGSTATUSPROCPTR (find-mactype :POINTER));  FUNCTION SIGStatusProcPtr(): BOOLEAN;
  178.  
  179. ; 
  180. ; Resource id of standard signature icon suite, all sizes and colors are available.
  181. ; 
  182.  
  183. (defconstant $kSIGSignatureIconResID -16797)    ; Note that this is the FINAL value for this constant, not the BETA value!
  184.  
  185. ;  ——————————————————————————————— CONTEXT CALLS ——————————————————————————————— 
  186. ; 
  187. ; To use the Digital Signature toolbox you will need a SIGContextPtr.  To create
  188. ; a SIGContextPtr you simply call SIGNewContext and it will create and initialize
  189. ; a context for you.  To free the memory occupied by the context and invalidate
  190. ; its internal data, call SIGDisposeContext. An initialized context has no notion
  191. ; of the type of operation it will be performing however, once you call
  192. ; SIGSignPrepare SIGVerifyPrepare, or SIGDigestPrepare, the contexts operation
  193. ; type is set and to switch  to another type of operation will require creating a
  194. ; new context. Be sure to pass the same context to corresponding toolbox calls
  195. ; (ie: SIGSignPrepare; SIGProcessData, SIGSign)  in other words mixing lets say
  196. ; signing and verify calls with the same context is not allowed.
  197. ; 
  198.  
  199.  
  200. (deftrap _signewcontext ((context (:pointer :pointer)))
  201.    (:stack :signed-integer)
  202.    (:stack-trap #xAA5D :d0 (+ (ash 2 16) 1900) context))
  203.  
  204.  
  205. (deftrap _sigdisposecontext ((context :pointer))
  206.    (:stack :signed-integer)
  207.    (:stack-trap #xAA5D :d0 (+ (ash 2 16) 1901) context))
  208.  
  209. ;  ——————————————————————————————— SIGNING CALLS ——————————————————————————————— 
  210. ; 
  211. ; Once you have created a SIGContextPtr, you create a signature by calling
  212. ; SIGSignPrepare once, followed by n calls to SIGProcessData, followed by one call
  213. ; to SIGSign. To create another signature on different data but for the same
  214. ; signer, don't dispose of the context and call SIGProcessData for the new data
  215. ; followed by a call SIGSign again. In this case the signer will not be prompted
  216. ; for their signer and password again as it was already provided.  Once you call
  217. ; SIGDisposeContext, all signer information will be cleared out of the context and
  218. ; the signer will be re-prompted.  The signer file FSSpecPtr should be set to nil
  219. ; if you want the toolbox to use the last signer by default or prompt for a signer
  220. ; if none exists.  The prompt parameter can be used to pass a string to be displayed
  221. ; in the dialog that prompts the user for their password.  If the substring "^1"
  222. ; (without the quotes) is in the prompt string, then the toolbox will replace it
  223. ; with the name of the signer from the signer selected by the user.  If an empty
  224. ; string is passed, the following default string will be sent to the toolbox
  225. ; "\pSigning as ^1.".  You can call any of the utility routines after SIGSignPrepare
  226. ; or SIGSign to get information about the signer or certs.
  227. ; 
  228.  
  229.  
  230. (deftrap _sigsignprepare ((context :pointer) (signerfile (:pointer :fsspec)) (prompt (:pointer (:string 255))) (signaturesize (:pointer :signed-long)))
  231.    (:stack :signed-integer)
  232.    (:stack-trap #xAA5D :d0 (+ (ash 8 16) 1902) context signerfile prompt signaturesize))
  233.  
  234.  
  235. (deftrap _sigsign ((context :pointer) (signature :pointer) (statusproc :pointer))
  236.    (:stack :signed-integer)
  237.    (:stack-trap #xAA5D :d0 (+ (ash 6 16) 1903) context signature statusproc))
  238.  
  239. ;  ——————————————————————————————— VERIFYING CALLS ——————————————————————————————— 
  240. ; 
  241. ; Once you have created a SIGContextPtr, you verify a signature by calling
  242. ; SIGVerifyPrepare  once, followed by n calls to SIGProcessData, followed by one
  243. ; call to SIGVerify. Check the return code from SIGVerify to see if the signature
  244. ; verified or not (noErr is returned on  success otherwise the appropriate error
  245. ; code).  Upon successfull verification, you can call any of the utility routines
  246. ; to find out who signed the data.
  247. ; 
  248.  
  249.  
  250. (deftrap _sigverifyprepare ((context :pointer) (signature :pointer) (signaturesize :signed-long) (statusproc :pointer))
  251.    (:stack :signed-integer)
  252.    (:stack-trap #xAA5D :d0 (+ (ash 8 16) 1904) context signature signaturesize statusproc))
  253.  
  254.  
  255. (deftrap _sigverify ((context :pointer))
  256.    (:stack :signed-integer)
  257.    (:stack-trap #xAA5D :d0 (+ (ash 2 16) 1905) context))
  258.  
  259. ;  —————————————————————————————— DIGESTING CALLS —————————————————————————————— 
  260. ; 
  261. ; Once you have created a SIGContextPtr, you create a digest by calling
  262. ; SIGDigestPrepare once, followed by n calls to SIGProcessData, followed by one
  263. ; call to SIGDigest.  You can dispose of the context after SIGDigest as the
  264. ; SIGDigestData does not reference back into it.  SIGDigest returns the digest in
  265. ; digest.
  266. ; 
  267.  
  268.  
  269. (deftrap _sigdigestprepare ((context :pointer))
  270.    (:stack :signed-integer)
  271.    (:stack-trap #xAA5D :d0 (+ (ash 2 16) 1906) context))
  272.  
  273.  
  274. (deftrap _sigdigest ((context :pointer) (digest (:array :unsigned-byte (- \#$KSIGDIGESTSIZE 1 -1))))
  275.    (:stack :signed-integer)
  276.    (:stack-trap #xAA5D :d0 (+ (ash 4 16) 1907) context digest))
  277.  
  278. ;  —————————————————————————————— PROCESSING DATA —————————————————————————————— 
  279. ; 
  280. ; To process data during a digest, sign, or verify operation call SIGProcessData
  281. ; as many times as necessary and with any sized blocks of data.  The data needs to
  282. ; be processed in the same order during corresponding sign and verify operations
  283. ; but does not need to be processed in the same sized chunks (i.e., the toolbox
  284. ; just sees it as a continuous bit stream).
  285. ; 
  286.  
  287.  
  288. (deftrap _sigprocessdata ((context :pointer) (data :pointer) (datasize :signed-long))
  289.    (:stack :signed-integer)
  290.    (:stack-trap #xAA5D :d0 (+ (ash 6 16) 1908) context data datasize))
  291.  
  292. ;  ——————————————————————————————— UTILITY CALLS ——————————————————————————————— 
  293. ; 
  294. ; Given a context that has successfully performed a verification SIGShowSigner
  295. ; will  display a modal dialog with the entire distinguished name of the person
  296. ; who signed the data. the prompt (if supplied) will appear at the top of the
  297. ; dialog.  If no prompt is specified, the default prompt "\pVerification
  298. ; Successfull." will appear.
  299. ; 
  300. ; Given a context that has been populated by calling SIGSignPrepare, SIGSign or a
  301. ; successful SIGVerify, you can make the remaining utility calls:
  302. ; 
  303. ; SIGGetSignerInfo will return the SignerInfo record.  The certCount can be used
  304. ; to index into the certificate set when calling SIGGetCertInfo,
  305. ; SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes. The signingTime is
  306. ; only defined if the call is made after SIGSign  or SIGVerify. The certSetStatus
  307. ; will tell you the best status of the entire certificate set while
  308. ; certSetStatusTime will correspond to the time associated with that status (see
  309. ; definitions above).
  310. ; 
  311. ; SIGGetCertInfo will return the SIGCertInfo record when given a valid index into
  312. ; the cert set in  certIndex.  Note: The cert at index kSIGSignerCertIndex is
  313. ; always the signers certificate.  The  serial number, start date and end date
  314. ; are there should you wish to display that info.  The  certAttributeCount and
  315. ; issuerAttributeCount provide the number of parts in the name of that certificate
  316. ; or that certificates issuer respectively.  You use these numbers to index into
  317. ; either SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes to retrieve
  318. ; the name. The certStatus will tell you the status of the certificate while
  319. ; certStatusTime will correspond to the time associated with that status (see
  320. ; definitions above).
  321. ; 
  322. ; SIGGetCertNameAttributes and SIGGetCertIssuerNameAttributes return name parts
  323. ; of the certificate at  certIndex and attributeIndex.  The newLevel return value
  324. ; tells you wether the name attribute returned is at the same level in the name
  325. ; hierarchy as the previous attribute.  The type return value tells you  the type
  326. ; of attribute returned. nameAttribute is the actual string containing the name
  327. ; attribute.   So, if you wanted to display the entire distinguished name of the
  328. ; person who's signature was just validated you could do something like this;
  329. ; 
  330. ;     (…… variable declarations and verification code would preceed this sample ……)
  331. ; 
  332. ;     error = SIGGetCertInfo(verifyContext, kSIGSignerCertIndex, &certInfo);
  333. ;     HandleErr(error);
  334. ; 
  335. ;     for (i = 0; i <= certInfo.certAttributeCount-1; i++)
  336. ;         error = SIGGetCertNameAttributes(verifyContext, kSIGSignerCertIndex, i, &newLevel, &type, theAttribute);
  337. ;         HandleErr(error);
  338. ;         DisplayNamePart(theAttribute, type, newLevel);
  339. ; 
  340.  
  341.  
  342. (deftrap _sigshowsigner ((context :pointer) (prompt (:pointer (:string 255))))
  343.    (:stack :signed-integer)
  344.    (:stack-trap #xAA5D :d0 (+ (ash 4 16) 1909) context prompt))
  345.  
  346.  
  347. (deftrap _siggetsignerinfo ((context :pointer) (signerinfo (:pointer :sigsignerinfo)))
  348.    (:stack :signed-integer)
  349.    (:stack-trap #xAA5D :d0 (+ (ash 4 16) 1910) context signerinfo))
  350.  
  351.  
  352. (deftrap _siggetcertinfo ((context :pointer) (certindex :signed-long) (certinfo (:pointer :sigcertinfo)))
  353.    (:stack :signed-integer)
  354.    (:stack-trap #xAA5D :d0 (+ (ash 6 16) 1911) context certindex certinfo))
  355.  
  356.  
  357. (deftrap _siggetcertnameattributes ((context :pointer) (certindex :signed-long) (attributeindex :signed-long) (attributeinfo (:pointer :signameattributesinfo)))
  358.    (:stack :signed-integer)
  359.    (:stack-trap #xAA5D :d0 (+ (ash 8 16) 1912) context certindex attributeindex attributeinfo))
  360.  
  361.  
  362. (deftrap _siggetcertissuernameattributes ((context :pointer) (certindex :signed-long) (attributeindex :signed-long) (attributeinfo (:pointer :signameattributesinfo)))
  363.    (:stack :signed-integer)
  364.    (:stack-trap #xAA5D :d0 (+ (ash 8 16) 1913) context certindex attributeindex attributeinfo))
  365.  
  366. ;  ——————————————————————————— FILE SIGN & VERIFY CALLS —————————————————————————— 
  367. ; 
  368. ; These calls allow you to detect the presence of a standard signtaure in a file as
  369. ; well as sign and verify files in a standard way.  An example of this is the Finder,
  370. ; which uses these calls to allow the user to "drop sign" a file.
  371. ; 
  372. ; To detect if a file is signed in the standard way, pass the FSSpec of the file to SIGFileIsSigned.
  373. ; A result of noErr means the file is in fact signed, otherwise, a kSIGNoSignature error will
  374. ; be returned.
  375. ; 
  376. ; Once you have created a SIGContextPtr, you can make calls to either sign or verify a file in
  377. ; a standard way:
  378. ; 
  379. ; To sign a file, call SIGSignPrepare followed by 'n' number of calls to SIGSignFile,
  380. ; passing it the file spec for each file you wish to sign in turn.  You supply the context, the signature
  381. ; size that was returned from SIGSignPrepare and an optional call back proc.  The call will take care of all
  382. ; the processing of data and affixing the signature to the file. If a signature already exists in the file,
  383. ; it is replaced with the newly created signature.
  384. ; 
  385. ; To verify a file that was signed using SIGSignFile, call SIGVerifyFile passing it a new context and
  386. ; the file spec.  Once this call has completed, if the verification is successfull, you can pass the context
  387. ; to SIGShowSigner to display the name of the person who signed the file.
  388. ; 
  389.  
  390.  
  391. (deftrap _sigfileissigned ((filespec :fsspec))
  392.    (:stack :signed-integer)
  393.    (:stack-trap #xAA5D :d0 (+ (ash 2 16) 2500) filespec))
  394.  
  395.  
  396. (deftrap _sigsignfile ((context :pointer) (signaturesize :signed-long) (filespec :fsspec) (statusproc :pointer))
  397.    (:stack :signed-integer)
  398.    (:stack-trap #xAA5D :d0 (+ (ash 8 16) 2501) context signaturesize filespec statusproc))
  399.  
  400.  
  401. (deftrap _sigverifyfile ((context :pointer) (filespec :fsspec) (statusproc :pointer))
  402.    (:stack :signed-integer)
  403.    (:stack-trap #xAA5D :d0 (+ (ash 6 16) 2502) context filespec statusproc))
  404.  
  405. ; $ENDC                         ;  UsingDigitalSignature 
  406.  
  407. ; $IFC NOT UsingIncludes
  408.  
  409. ; $ENDC
  410.  
  411. (export '($KSIGSIGNATUREICONRESID $KSIGSIGNERCERTINDEX $KSIGDIGESTSIZE
  412.           $GESTALTDIGITALSIGNATUREVERSION $KSIGINVALID $KSIGEXPIRED
  413.           $KSIGPENDING $KSIGVALID $KSIGPOSTALCODE $KSIGORGANIZATIONUNIT
  414.           $KSIGTITLE $KSIGCOMMONNAME $KSIGLOCALITY $KSIGSTATE
  415.           $KSIGSTREETADDRESS $KSIGORGANIZATION $KSIGCOUNTRYCODE $KSIGVERIFYFILE
  416.           $KSIGSIGNFILE $KSIGFILEISSIGNED $KSIGGETCERTISSUERNAMEATTRIBUTES
  417.           $KSIGGETCERTNAMEATTRIBUTES $KSIGGETCERTINFO $KSIGGETSIGNERINFO
  418.           $KSIGSHOWSIGNER $KSIGPROCESSDATA $KSIGDIGEST $KSIGDIGESTPREPARE
  419.           $KSIGVERIFY $KSIGVERIFYPREPARE $KSIGSIGN $KSIGSIGNPREPARE
  420.           $KSIGDISPOSECONTEXT $KSIGNEWCONTEXT))
  421. (provide-interface 'DigitalSignature)